/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2021 Tencent.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.tencent.bkrepo.common.storage.core.operation

import com.tencent.bkrepo.common.storage.credentials.StorageCredentials

/**
 * 存储压缩操作
 * */
interface CompressOperation {
    /**
     * 压缩[digest]
     *
     * 使用BD压缩，压缩[digest]。[base]与[digest]越相似，压缩率越高。压缩后生成digest.bd压缩文件
     * @param keep 压缩后，源文件是否保留
     * @return 压缩后的文件大小，-1表示未进行压缩
     * */
    fun compress(
        digest: String,
        digestSize: Long? = null,
        base: String,
        baseSize: Long? = null,
        storageCredentials: StorageCredentials?,
        keep: Boolean = false,
    ): Long

    /**
     * 解压[digest],解压成功后，删除bd压缩文件
     *
     * @return 返回1表示成功解压，否则返回0
     * */
    fun uncompress(
        digest: String,
        digestSize: Long? = null,
        base: String,
        baseSize: Long? = null,
        storageCredentials: StorageCredentials?,
    ): Int

    /**
     * [digest]是否被压缩
     * @return true文件被压缩，false文件未被压缩
     * */
    fun isCompressed(digest: String, storageCredentials: StorageCredentials?): Boolean

    /**
     * 删除[digest]压缩文件
     * */
    fun deleteCompressed(digest: String, storageCredentials: StorageCredentials?)
}
